/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.gds.indirectExposure;

import org.neo4j.gds.NodeLabel;
import org.neo4j.gds.RelationshipType;
import org.neo4j.gds.annotation.Configuration;
import org.neo4j.gds.api.GraphStore;
import org.neo4j.gds.beta.pregel.Partitioning;
import org.neo4j.gds.beta.pregel.PregelConfig;
import org.neo4j.gds.config.RelationshipWeightConfig;

import java.util.Collection;
import java.util.Set;
import java.util.stream.Collectors;

import static org.neo4j.gds.utils.StringFormatting.formatWithLocale;

@Configuration("IndirectExposureConfigImpl")
public interface IndirectExposureConfig extends PregelConfig {

    String sanctionedProperty();

    @Override
    @Configuration.Ignore
    default boolean trackSender() {
        return true;
    }

    @Override
    @Configuration.Ignore
    default boolean isAsynchronous() {
        return false;
    }

    @Override
    @Configuration.Ignore
    default Partitioning partitioning() {
        return Partitioning.AUTO;
    }

    @Configuration.Check
    default void validateRelationshipWeightIsPresent() {
        if (!hasRelationshipWeightProperty()) {
            throw new IllegalArgumentException(
                formatWithLocale(
                    "Indirect exposure requires `%s` to be set.",
                    RelationshipWeightConfig.RELATIONSHIP_WEIGHT_PROPERTY
                ));
        }
    }

    @Configuration.GraphStoreValidationCheck
    default void validateGraphIsUndirected(
        GraphStore graphStore,
        Collection<NodeLabel> ignored,
        Collection<RelationshipType> selectedRelationshipTypes
    ) {
        if (!graphStore.schema().filterRelationshipTypes(Set.copyOf(selectedRelationshipTypes)).isUndirected()) {
            throw new IllegalArgumentException(formatWithLocale(
                "Indirect exposure requires relationship projections to be UNDIRECTED. " +
                    "Selected relationships `%s` are not all undirected.",
                selectedRelationshipTypes.stream().map(RelationshipType::name).collect(Collectors.toSet())
            ));
        }
    }
}
